////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2008 Michiel Helvensteijn                                    //
//                                                                            //
// This file is part of the Mist compiler.                                    //
//                                                                            //
// The Mist compiler is free software: you can redistribute it and/or modif   //
// it under the terms of the GNU General Public License as published by       //
// the Free Software Foundation, either version 3 of the License, or          //
// (at your option) any later version.                                        //
//                                                                            //
// The Mist compiler is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of             //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              //
// GNU General Public License for more details.                               //
//                                                                            //
// You should have received a copy of the GNU General Public License          //
// along with the Mist compiler.  If not, see <http://www.gnu.org/licenses/>. //
////////////////////////////////////////////////////////////////////////////////

#ifndef MESSAGE_HPP
#define MESSAGE_HPP

/******************************************************************************
 * Includes                                                                   *
 ******************************************************************************/

#include <string>
using std::string;

#include <ostream>
using std::ostream;

#include <boost/operators.hpp>
using boost::partially_ordered;
using boost::equality_comparable;

#include <boost/format.hpp>
using boost::format;

#include "messageinfo.hpp"
#include "codelocation.hpp"

/******************************************************************************
 * Message Class                                                              *
 ******************************************************************************/

class Message : public partially_ordered<Message>, public equality_comparable<Message> {
	public:
		
		Message(MessageSeverity severity, const string& message);
		Message(MessageSeverity severity, CodeLocation location, const string& message);
		Message(const string& code);
		Message(const string& code, CodeLocation location);
		
		template <class T>
		Message& operator%(T arg);
		
		const string& code() const;
		
		bool code_is_set() const;
		
		MessageSeverity severity() const;
		
		bool location_is_set() const;
		
		const CodeLocation& location() const;
		
		string message() const;
		
		ostream& report_to_stream(ostream& out) const;
		
		bool operator<(const Message& other) const;
		
		bool operator==(const Message& other) const;
	
	private:
		
		string          _code;
		MessageSeverity _severity;
		bool            _locationIsSet;
		CodeLocation    _location;
		format          _message;
};

/******************************************************************************
 * Output Stream Operator                                                     *
 ******************************************************************************/

ostream& operator<<(ostream& out, const Message& message);

/******************************************************************************
 * Template Function Implementations                                          *
 ******************************************************************************/

template <class T>
Message& Message::operator%(T arg) {
	_message % arg;
	return *this;
}

#endif // MESSAGE_HPP
